home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / stbsv.z / stbsv
Encoding:
Text File  |  2002-10-03  |  20.7 KB  |  463 lines

  1.  
  2.  
  3.  
  4. SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSSSTTTTBBBBSSSSVVVV, DDDDTTTTBBBBSSSSVVVV, CCCCTTTTBBBBSSSSVVVV, ZZZZTTTTBBBBSSSSVVVV - Solves a real or complex triangular banded
  10.      system of equations
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      Single precision
  14.  
  15.           Fortran:
  16.                CCCCAAAALLLLLLLL SSSSTTTTBBBBSSSSVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _k,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  17.  
  18.           C/C++:
  19.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  20.                vvvvooooiiiidddd ssssttttbbbbssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,, iiiinnnntttt _k,,,,
  21.                ffffllllooooaaaatttt *_a,,,, iiiinnnntttt _l_d_a,,,, ffffllllooooaaaatttt *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  22.  
  23.      Double precision
  24.  
  25.           Fortran:
  26.                CCCCAAAALLLLLLLL DDDDTTTTBBBBSSSSVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _k,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  27.  
  28.           C/C++:
  29.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  30.                vvvvooooiiiidddd ddddttttbbbbssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,, iiiinnnntttt _k,,,,
  31.                ddddoooouuuubbbblllleeee *_a,,,, iiiinnnntttt _l_d_a,,,, ddddoooouuuubbbblllleeee *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  32.  
  33.      Single precision complex
  34.  
  35.           Fortran:
  36.                CCCCAAAALLLLLLLL CCCCTTTTBBBBSSSSVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _k,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  37.  
  38.           C/C++:
  39.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  40.                vvvvooooiiiidddd ccccttttbbbbssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,, iiiinnnntttt _k,,,,
  41.                ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a,,,, iiiinnnntttt _l_d_a,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  42.  
  43.           C++ STL:
  44.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  45.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  46.                vvvvooooiiiidddd ccccttttbbbbssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,, iiiinnnntttt _k,,,,
  47.                ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a,,,, iiiinnnntttt _l_d_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  48.  
  49.      Double precision complex
  50.  
  51.           Fortran:
  52.                CCCCAAAALLLLLLLL ZZZZTTTTBBBBSSSSVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _k,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  53.  
  54.           C/C++:
  55.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  56.                vvvvooooiiiidddd zzzzttttbbbbssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr _d_i_a_g,,,, iiiinnnntttt _n,,,, iiiinnnntttt _k,,,,
  57.                ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a,,,, iiiinnnntttt _l_d_a,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.           C++ STL:
  75.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  76.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  77.                vvvvooooiiiidddd zzzzttttbbbbssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,, iiiinnnntttt _k,,,,
  78.                ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_a,,,, iiiinnnntttt _l_d_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  79.  
  80. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  81.      These routines are part of the SCSL Scientific Library and can be loaded
  82.      using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
  83.      directs the linker to use the multi-processor version of the library.
  84.  
  85.      When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
  86.      4 bytes (32 bits). Another version of SCSL is available in which integers
  87.      are 8 bytes (64 bits).  This version allows the user access to larger
  88.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  89.      by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
  90.      only one of the two versions; 4-byte integer and 8-byte integer library
  91.      calls cannot be mixed.
  92.  
  93.      The C and C++ prototypes shown above are appropriate for the 4-byte
  94.      integer version of SCSL. When using the 8-byte integer version, the
  95.      variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
  96.      file should be included.
  97.  
  98. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  99.      SSSSTTTTBBBBSSSSVVVV and DDDDTTTTBBBBSSSSVVVV solve a real triangular banded system of equations.
  100.  
  101.      CCCCTTTTBBBBSSSSVVVV and ZZZZTTTTBBBBSSSSVVVV solve a complex triangular banded system of equations.
  102.  
  103.      These routines solve one of the following systems of equations, using the
  104.      operation associated with each:
  105.  
  106.           EEEEqqqquuuuaaaattttiiiioooonnnnssss      OOOOppppeeeerrrraaaattttiiiioooonnnn
  107.  
  108.           _A_x=_b           _x <- _A-_1_x
  109.  
  110.           _A_T_x=_b          _x <- _A-_T_x
  111.  
  112.           _A_H_x=_b          _x <- _A-_H_x (CCCCTTTTBBBBSSSSVVVV and ZZZZTTTTBBBBSSSSVVVV only)
  113.  
  114.      where
  115.  
  116.      *   _b and _x are _n-element vectors
  117.  
  118.      *   _A is either a unit or nonunit _n-by-_n upper or lower triangular band
  119.          matrix with (_k+1) diagonals
  120.  
  121.      *   _A-_1 is the inverse of _A
  122.  
  123.      *   _A_T is the transpose of _A
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      *   _A-_T is the inverse of _A_T
  141.  
  142.      *   _A_H is the conjugate transpose of _A
  143.  
  144.      *   _A-_H is the inverse of _A_H
  145.  
  146.      On input, the right-hand side vector _b is stored in the array argument _x.
  147.      On output, the solution vector _x overwrites _b in the same array argument
  148.      _x.
  149.  
  150.      See the NOTES section of this man page for information about the
  151.      interpretation of the data types described in the following arguments.
  152.  
  153.      These routines have the following arguments:
  154.  
  155.      _u_p_l_o      Character.  (input)
  156.                Specifies whether the matrix is an upper or lower triangular
  157.                matrix, as follows:
  158.  
  159.                _u_p_l_o = 'U' or 'u': _A is an upper triangular matrix.
  160.                _u_p_l_o = 'L' or 'l': _A is a lower triangular matrix.
  161.  
  162.                For C/C++, a pointer to this character is passed.
  163.  
  164.      _t_r_a_n_s     Character.  (input)
  165.                Specifies the operation to be performed, as follows:
  166.  
  167.                _t_r_a_n_s = 'N' or 'n':  _x <- _A-_1_x
  168.  
  169.                _t_r_a_n_s = 'T' or 't':  _x <- _A-_T_x
  170.  
  171.                _t_r_a_n_s = 'C' or 'c':  _x <- _A-_T_x (SSSSTTTTBBBBSSSSVVVV, DDDDTTTTBBBBSSSSVVVV), or _x <- _A-_H_x
  172.                (CCCCTTTTBBBBSSSSVVVV, ZZZZTTTTBBBBSSSSVVVV)
  173.  
  174.                For C/C++, a pointer to this character is passed.
  175.  
  176.      _d_i_a_g      Character.  (input)
  177.                Specifies whether _A is unit triangular, as follows:
  178.  
  179.                _d_i_a_g = 'U' or 'u':  _A is assumed to be unit triangular.
  180.                _d_i_a_g = 'N' or 'n':  _A is not assumed to be unit triangular.
  181.  
  182.                For C/C++, a pointer to this character is passed.
  183.  
  184.      _n         Integer.  (input)
  185.                Specifies the order of matrix _A.  _n >= 0.
  186.  
  187.      _k         Integer.  (input)
  188.                _u_p_l_o = 'U' or 'u':  _k specifies the number of superdiagonals of
  189.                matrix _A.
  190.                _u_p_l_o = 'L' or 'l' _k specifies the number of subdiagonals of
  191.                matrix _A.
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))
  203.  
  204.  
  205.  
  206.                _k >= 0.
  207.  
  208.      _a         Array of dimension (_l_d_a,_n).  (input)
  209.                SSSSTTTTBBBBSSSSVVVV: Single precision array.
  210.                DDDDTTTTBBBBSSSSVVVV: Double precision array.
  211.                CCCCTTTTBBBBSSSSVVVV: Single precison complex array.
  212.                ZZZZTTTTBBBBSSSSVVVV: Double precision complex array.
  213.  
  214.                Before entry with _u_p_l_o = 'U' or 'u', the leading (_k+1)-by-_n
  215.                upper triangular part of array _a must contain the upper
  216.                triangular band part of the matrix of coefficients, supplied
  217.                column-by-column, with the leading diagonal of the matrix in
  218.                row (_k+1) of the array, the first superdiagonal starting at
  219.                position 2 in row _k, and so on.  The top left _k-by-_k triangle
  220.                of array _a is not referenced.
  221.  
  222.                Before entry with _u_p_l_o = 'L' or 'l', the leading (_k+1)-by-_n
  223.                part of array _a must contain the lower triangular band part of
  224.                the matrix of coefficients, supplied column-by-column, with the
  225.                leading diagonal of the matrix in row 1 of the array, the first
  226.                subdiagonal starting at position 1 in row 2, and so on.  The
  227.                bottom right _k-by-_k triangle of array _a is not referenced.
  228.  
  229.                When _d_i_a_g = 'U' or 'u', these routines assume that all elements
  230.                of array _a that represent diagonal elements of the matrix _A are
  231.                1.  In this case, neither of these routines will reference any
  232.                of the diagonal elements.
  233.  
  234.      _l_d_a       Integer.  (input)
  235.                Specifies the first dimension of _a as declared in the calling
  236.                program.  _l_d_a >= (_k+1).
  237.  
  238.      _x         Array of dimension 1+(_n-1) * |_i_n_c_x|.  (input and output)
  239.                SSSSTTTTBBBBSSSSVVVV: Single precision array.
  240.                DDDDTTTTBBBBSSSSVVVV: Double precision array.
  241.                CCCCTTTTBBBBSSSSVVVV: Single precision complex array.
  242.                ZZZZTTTTBBBBSSSSVVVV: Double precision complex array.
  243.                Contains the vector _x.
  244.  
  245.                On input, _x contains the right-hand side vector _b.  On output,
  246.                the solution vector overwrites array _x.
  247.  
  248.      _i_n_c_x      Integer.  (input)
  249.                Specifies the increment for the elements of _x.  _i_n_c_x must not
  250.                be 0.
  251.  
  252. NNNNOOOOTTTTEEEESSSS
  253.      The following program segment transfers an upper triangular band matrix
  254.      from conventional full matrix storage to band storage:
  255.  
  256.               DO 20, J = 1, N
  257.                  M = K + 1 - J
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))
  269.  
  270.  
  271.  
  272.                  DO 10, I = MAX( 1, J - K ), J
  273.                     A( M + I, J ) = MATRIX( I, J )
  274.           10     CONTINUE
  275.           20  CONTINUE
  276.  
  277.  
  278.      The following program segment transfers a lower triangular band matrix
  279.      from conventional full matrix storage to band storage:
  280.  
  281.               DO 20, J = 1, N
  282.                  M = 1 - J
  283.                  DO 10, I = J, MIN( N, J + K )
  284.                     A( M + I, J ) = MATRIX( I, J )
  285.           10     CONTINUE
  286.           20  CONTINUE
  287.  
  288.  
  289.      Tests for singularity or near-singularity are not included in these
  290.      routines.  You must perform such tests before calling these routines.
  291.  
  292.      These routines are Level 2 Basic Linear Algebra Subprograms (Level 2
  293.      BLAS).
  294.  
  295.      When working backward (_i_n_c_x < 0), each routine starts at the end of the
  296.      vector and moves backward, as follows:
  297.  
  298.           _x(1-_i_n_c_x * (_n-1)), _x(1-_i_n_c_x * (_n-2)), ..., _x(1)
  299.  
  300.  
  301.    DDDDaaaattttaaaa TTTTyyyyppppeeeessss
  302.      The following data types are described in this documentation:
  303.  
  304.           TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee
  305.  
  306.      Fortran:
  307.  
  308.           Array dimensioned _n           xxxx((((nnnn))))
  309.  
  310.           Array of dimensions (_m,_n)     xxxx((((mmmm,,,,nnnn))))
  311.  
  312.           Character                     CCCCHHHHAAAARRRRAAAACCCCTTTTEEEERRRR
  313.  
  314.           Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  315.  
  316.           Single precision              RRRREEEEAAAALLLL
  317.  
  318.           Double precision              DDDDOOOOUUUUBBBBLLLLEEEE PPPPRRRREEEECCCCIIIISSSSIIIIOOOONNNN
  319.  
  320.           Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))
  335.  
  336.  
  337.  
  338.           Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  339.  
  340.      C/C++:
  341.  
  342.           Array dimensioned _n           xxxx[[[[_n]]]]
  343.  
  344.           Array of dimensions (_m,_n)     xxxx[[[[mmmm****nnnn]]]]
  345.  
  346.           Character                     cccchhhhaaaarrrr
  347.  
  348.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  349.  
  350.           Single precision              ffffllllooooaaaatttt
  351.  
  352.           Double precision              ddddoooouuuubbbblllleeee
  353.  
  354.           Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  355.  
  356.           Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  357.  
  358.      C++ STL:
  359.  
  360.           Array dimensioned _n           xxxx[[[[_n]]]]
  361.  
  362.           Array of dimensions (_m,_n)     xxxx[[[[mmmm****nnnn]]]]
  363.  
  364.           Character                     cccchhhhaaaarrrr
  365.  
  366.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  367.  
  368.           Single precision              ffffllllooooaaaatttt
  369.  
  370.           Double precision              ddddoooouuuubbbblllleeee
  371.  
  372.           Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  373.  
  374.           Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  375.  
  376.      Note that you can explicitly declare multidimensional C/C++ arrays
  377.      provided that the array dimensions are swapped with respect to the
  378.      Fortran declaration (e.g., xxxx[[[[nnnn]]]][[[[mmmm]]]] in C/C++ versus xxxx((((mmmm,,,,nnnn)))) in Fortran).
  379.      To avoid a compiler type mismatch error in C++ (or a compiler warning
  380.      message in C), however, the array should be cast to a pointer of the
  381.      appropriate type when passed as an argument to a SCSL routine.
  382.  
  383. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  384.      IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS2222(3S)
  385.  
  386.      IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
  387.      Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
  388.      Linear Algebra Subprograms Technical Forum.
  389.  
  390.  
  391.  
  392.  
  393.                                                                         PPPPaaaaggggeeee 6666
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTBBBBSSSSVVVV((((3333SSSS))))
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.                                                                         PPPPaaaaggggeeee 7777
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.